Carbon


DMGetNameByAVID

Header: Displays.h Carbon status: Supported

Obtains the name of a display device.

OSErr DMGetNameByAVID (
    AVIDType theID, 
    UInt32 nameFlags, 
    Str255 name
);
theID

The ID number of the display device whose name you want to obtain.

nameFlags

Reserved for future expansion. Pass NULL in this parameter.

name

On return, a string containing the name of the display device specified by the parameter theID.

function result

A result code.

DISCUSSION

An AVID is really a display ID as an AVID references a video display just like a display ID. Developers planned to use AVIDs for an extended set of devices, however, they never did this.

SPECIAL CONSIDERATIONS

Because this function may move or purge memory blocks or access handles, you cannot call it at interrupt time.

AVAILABILITY

Supported in Carbon. Available in CarbonLib 1.0 and later when DisplayLib 2.0 (or later) or DisplayLib68k 2.0 (or later) is installed. Exported by CarbonLib 1.0 and later, DisplayLib 2.0 and later, and by DisplayLib68k 2.0 and later.


© 2000 Apple Computer, Inc. — (Last Updated 3/8/2000)